home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / bbsutil / fce10.zip / FCE.DOC < prev    next >
Text File  |  1991-08-30  |  29KB  |  802 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                         FCE: File Comment Extractor
  7.                           DOS Edition, Version 1.0
  8.                       ────────────────────────────────
  9.                       (C) Copyright 1991 by Andy Hakim
  10.                             All Rights Reserved
  11.  
  12.  
  13.                       R E F E R E N C E    M A N U A L
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.         For a quick summary of options, type FCE at the dos prompt.
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.                              TABLE OF CONTENTS
  68.  
  69. ADDRESSES ..............................................................  1
  70.  
  71. SOFTWARE LICENSE  ......................................................  1
  72.  
  73. NOTATIONS/TERMINOLOGY ..................................................  1
  74.  
  75. WHAT IS FCE?  ..........................................................  2
  76.  
  77. WILL FCE BE USEFUL TO YOU?  ............................................  2
  78.  
  79. SEARCH STRATEGY ........................................................  3
  80.  
  81. SYSTEM REQUIREMENTS ....................................................  3
  82.  
  83. TEXT FILES  ............................................................  4
  84.  
  85. COMMAND LINE SYNTAX ....................................................  4
  86.      <inputfile>  ......................................................  4
  87.      <wildcards>  ......................................................  4
  88.      <scanfile[.lst]> ..................................................  4
  89.      [outputfile] ......................................................  4
  90.      [options]  ........................................................  4
  91.  
  92. COMMAND LINE OPTIONS  ..................................................  5
  93.      /? ................................................................  5
  94.      /F=# ..............................................................  5
  95.      /T=# ..............................................................  5
  96.      /M ................................................................  5
  97.      /C ................................................................  5
  98.      /O ................................................................  5
  99.      /S ................................................................  6
  100.      /I<F,E>  ..........................................................  6
  101.      /CLS=# ............................................................  6
  102.      /CO<O,S>=# ........................................................  6
  103.      /FL<I,S>=# ........................................................  6
  104.      /C=<file[.cfg]>  ..................................................  7
  105.      /EMS=# ............................................................  7
  106.  
  107. COMMAND LINE EXAMPLES ..................................................  8
  108.  
  109. FILE PROCESSING SCREEN  ................................................  9
  110.  
  111. ERROR MESSAGES  ........................................................  9
  112.  
  113. PROJECT HISTORY ........................................................ 10
  114.  
  115. SOURCE CODE ............................................................ 10
  116.  
  117. TRADEMARKS ............................................................. 10
  118.  
  119. REVISION HISTORY  ...................................................... 11
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133. FCE version 1.0  Reference Manual                                   Page: 1
  134. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  135.  
  136.  
  137. ADDRESSES
  138. ───────────────────────────────────────────────────────────────────────────
  139. Comments, suggestions, or questions?  You can contact me via:
  140.  
  141.  
  142.                    US Mail │ FCE Development
  143.                            │ P.O. Box 70392
  144.                            │ Houston, TX 77270-0392
  145.                            │
  146.                  Telephone │ (713) 880-3059
  147.                            │
  148.            Electronic Mail │ st144@menudo.uh.edu
  149.       (Internet addresses) │ cosc12r2@jetson.uh.edu
  150.                            │
  151.             Bulletin Board │ Sand's BBS
  152.                            │ (713) 961-1604
  153.                            │ 2400/9600/14400 baud, HST/v.32
  154.                            │ Username: Andy Hakim
  155.  
  156.  
  157.  
  158.  
  159.  
  160. SOFTWARE LICENSE
  161. ───────────────────────────────────────────────────────────────────────────
  162. FCE (DOS Edition, v1.0) is a free, public domain program.  There is no
  163. registration process or monetary fee required in order to use it.
  164.  
  165. You may freely distribute FCE to others as long as:
  166.  
  167.                ■ Only the original files are distributed
  168.                ■ No changes are made to any files
  169.                ■ No money is charged for the program
  170.  
  171. FCE, its documentation, and all related files are (C) Copyright 1991 by
  172. Andy Hakim.  All Rights Reserved.  The author of this program is not liable
  173. for any damage caused by its use.  By using this program, you agree to the
  174. above conditions.
  175.  
  176. If you find FCE useful, I would appreciate it if you let me know.
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184. NOTATIONS/TERMINOLOGY
  185. ───────────────────────────────────────────────────────────────────────────
  186. The following notations are used in this documentation:
  187.  
  188.                 <> describes a required parameter
  189.                 [] describes an optional parameter
  190.                 {} describes a default parameter
  191.  
  192. Do not type <>, [], or {}, only the information inside them.
  193.  
  194. You should be familiar with basic DOS concepts such as wildcards, paths,
  195. subdirectories and text files.  If those concepts are foreign to you,
  196. refer to your DOS manual.  There are also many books written on
  197. understanding DOS.
  198.  
  199. FCE version 1.0  Reference Manual                                   Page: 2
  200. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  201.  
  202. WHAT IS FCE?
  203. ───────────────────────────────────────────────────────────────────────────
  204. FCE is an abbreviation for File Comment Extractor.  It is a utility that
  205. compares two text files that contain filenames and comments, and tries to
  206. match filenames.  On a successful match, the comment is copied from the
  207. scan file to the output file.  For example:
  208.  
  209. Contents of file one (files you have downloaded from a bbs):
  210. ┌─────────────────────────────────────────────────────────────────────────┐
  211. │  SOLAR   .ZIP                                                           │
  212. │  386UTILS.ZIP                                                           │
  213. │  MICRODRW.ZIP                                                           │
  214. │  MOUSEADJ.ZIP                                                           │
  215. └─────────────────────────────────────────────────────────────────────────┘
  216.  
  217. Contents of file two (a file list from your favorite bbs)
  218. ┌─────────────────────────────────────────────────────────────────────────┐
  219. │  MOUSEADJ.ZIP     Mouse adjustment utility                              │
  220. │  GUMBY   .ZIP     Doubles your cpu speed (386/33 -> 386/66)!            │
  221. │  MICRODRW.ZIP     Micro Draw -- easy to use drawing program             │
  222. │  POKEY   .ZIP     Use modem lights as infrared signals!                 │
  223. │  386UTILS.ZIP     Useful utilities for 386 based pc's                   │
  224. │  PRICKLE .ZIP     Store up to 5mb on a 360k floppy -- works!            │
  225. └─────────────────────────────────────────────────────────────────────────┘
  226.  
  227. FCE's Output:
  228. ┌─────────────────────────────────────────────────────────────────────────┐
  229. │  SOLAR   .ZIP                                                           │
  230. │  386UTILS.ZIP     Useful utilities for 386's                            │
  231. │  MICRODRW.ZIP     Micro Draw -- easy to use drawing program             │
  232. │  MOUSEADJ.ZIP     Mouse adjustment utility                              │
  233. └─────────────────────────────────────────────────────────────────────────┘
  234.  
  235. If you are familiar with database operations, you may recognize that FCE is
  236. similar to a JOIN function.  FCE's advantage is that it operates on text
  237. files and saves you the trouble of converting the file to your database,
  238. defining fields, creating indexes, etc.  It also offers many features that
  239. may be hard or cumbersome to duplicate in a database.
  240.  
  241.  
  242.  
  243.  
  244.  
  245. WILL FCE BE USEFUL